

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Message (Sequence Diagram) [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Sequence,Sequence Message, Create,Message,Message Sequence, Create,Notation,Notation Co-Region,Co-Region Notation">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Message (Sequence Diagram)</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="message.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="self_message.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_TextIndentedL2"><img src="d_message.png" width="260" height="324" border="0" alt="d_message"></p>
<p class="p_BodyText"><span class="f_BodyText"><a href="sequencediagram.htm">Sequence diagrams</a> depict work flow or activity over time using Messages passed from element to element. These Messages correspond in the software model to Class operations and behavior. They are semantically similar to the Messages passed between elements in a Communication diagram, and can be of many different <a href="message_examples.htm">types</a>.</span></p>
<p class="p_BodyText"><span class="f_BodyText">To create a Message on a Sequence diagram, follow the steps below:</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">Access the Sequence diagram. The </span><span class="f_UIControl">Interaction</span><span class="f_NumberedList"> pages of the Enterprise Architect UML </span><span class="f_UIControl">Toolbox</span><span class="f_NumberedList"> display.</span></li>
<li value=2><span class="f_NumberedList">In the </span><span class="f_UIControl">Interaction Relationships</span><span class="f_NumberedList"> page, click on the </span><span class="f_MenuKeyField">Message</span><span class="f_NumberedList"> icon, click on the source object and drag the cursor to the destination (target) object. The </span><span class="f_UIControl">Message Properties</span><span class="f_NumberedList"> dialog displays (if not, right-click on the Message and select the </span><span class="f_MenuKeyField">Message Properties</span><span class="f_NumberedList"> menu option).</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<img src="messageproperties.png" width="412" height="549" border="0" alt="MessageProperties"><br>
<span class="f_NumberedList">&nbsp;</span></li>
<li value=3><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Message</span><span class="f_NumberedList"> field, type the Message name.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Notes:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><ul style="text-indent: 0px; margin-left: 14px; list-style-position: outside;">
<li><span class="f_TiporNoteText">If the Message flow is</span><span class="f_TiporNoteText" style="font-style: italic;"> towards</span><span class="f_TiporNoteText"> a <a href="class.htm">Class</a> element (dropped in from a Class diagram) or a <a href="lifeline.htm">Lifeline</a> element having a classifier, and the </span><span class="f_TiporNoteText" style="font-style: italic;">destination</span><span class="f_TiporNoteText"> Class has defined </span><span class="f_TiporNoteText" style="font-style: italic;">operations</span><span class="f_TiporNoteText">, you can click on the drop-down arrow and select an appropriate operation name. The Message then reflects the </span><span class="f_TiporNoteText">destination</span><span class="f_TiporNoteText"> Class operations.</span></li>
<li><span class="f_TiporNoteText">If the available operations are not appropriate, you can click on the </span><span class="f_MenuKeyField">Operations</span><span class="f_TiporNoteText"> button and define a new operation in the target element, using the </span><span class="f_UIControl"><a href="operationsmainpage.htm">Operations</a> </span><span class="f_TiporNoteText">dialog.</span></li>
<li><span class="f_TiporNoteText">If you create a Message without making reference to the target Class operations, no new operation is added to the target Class.</span></li>
</ul>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=4><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Parameters</span><span class="f_NumberedList"> field, type any parameters that the Message has, as a comma-separated list. If required, in the </span><span class="f_MenuKeyField">Parameter Values</span><span class="f_NumberedList"> field type the actual value for each parameter, again as a comma-separated list.</span></li>
<li value=5><span class="f_NumberedList">If the Message is a return message, in the </span><span class="f_MenuKeyField">Return Value</span><span class="f_NumberedList"> field enter the returned value or type.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">It is possible to depict returns from a <a href="self_message.htm">Self Message</a>. Simply create a second Self Message at the end of execution and select the </span><span class="f_MenuKeyField">Is Return</span><span class="f_TiporNoteText"> checkbox in the </span><span class="f_UIControl">Control Flow Type</span><span class="f_TiporNoteText"> panel.</span></p>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=6><span class="f_NumberedList">If the Message flow is </span><span class="f_NumberedList" style="font-style: italic;">from</span><span class="f_NumberedList"> a Class element or Lifeline element with classifier that has defined </span><span class="f_NumberedList" style="font-style: italic;">attributes</span><span class="f_NumberedList">, click on the drop-down arrow in the </span><span class="f_MenuKeyField">Assign to</span><span class="f_NumberedList"> field and select an appropriate attribute name. The Message reflects the attributes from the </span><span class="f_NumberedList" style="font-style: italic;">source</span><span class="f_NumberedList"> Class. You cannot add further attributes to the source Class here - if no appropriate attribute is listed, open the element</span><span class="f_UIControl"> Properties</span><span class="f_NumberedList"> dialog and add the required attribute.</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<span class="f_NumberedList">Otherwise, if required, type the name of the object to assign the message flow to.</span></li>
<li value=7><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Stereotype</span><span class="f_NumberedList"> field, type or select an optional </span><span class="f_Tabletext">stereotype for the connector (this is displayed on the diagram, if entered).</span></li>
<li value=8><span class="f_Tabletext">If required, in the</span><span class="f_MenuKeyField"> Alias</span><span class="f_Tabletext"> field type an alias for the name of the Message.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">On the diagram, the alias displays if the </span><span class="f_MenuKeyField">Use Alias if Available</span><span class="f_TiporNoteText"> checkbox is selected on the </span><span class="f_UIControl">Diagram</span><span class="f_TiporNoteText"> tab of the </span><span class="f_UIControl">Diagram Properties</span><span class="f_TiporNoteText"> dialog. The Alias displays instead of or as well as the Message name, depending on the setting selected in the </span><span class="f_UIControl">Alias Usage</span><span class="f_TiporNoteText"> panel of the </span><span class="f_UIControl"><a href="diagrambehavoir.htm">Diagram Behavior</a></span><span class="f_TiporNoteText"> page of the </span><span class="f_UIControl">Options</span><span class="f_TiporNoteText"> dialog.</span></p>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=9><span class="f_NumberedList">In the</span><span class="f_Tabletext"> </span><span class="f_MenuKeyField">Condition</span><span class="f_Tabletext"> </span><span class="f_NumberedList">field, type any conditions that must be true in order for the message to be sent.</span></li>
<li value=10><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Synch</span><span class="f_NumberedList">: field in the </span><span class="f_UIControl">Control Flow Type</span><span class="f_NumberedList"> panel, select </span><span class="f_MenuKeyField">Synchronous</span><span class="f_NumberedList"> or </span><span class="f_MenuKeyField">Asynchronous </span><span class="f_NumberedList">as appropriate.</span></li>
<li value=11><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Lifecycle</span><span class="f_NumberedList"> field, select </span><span class="f_MenuKeyField">New</span><span class="f_NumberedList"> to create a new element at the end of the Message, or </span><span class="f_MenuKeyField">Delete</span><span class="f_NumberedList"> to terminate the message flow at the end of the Message. If neither case applies, leave the field at the default of </span><span class="f_NumberedList" style="font-weight: bold;">&lt;none&gt;</span><span class="f_NumberedList">.</span></li>
<li value=12><span class="f_NumberedList">If required, in the </span><span class="f_MenuKeyField">Notes</span><span class="f_NumberedList"> field type any explanatory notes. You can format the notes using the </span><span class="f_UIControl"><a href="rich_text_notes_toolbar.htm">Rich Text Notes</a></span><span class="f_NumberedList"> toolbar at the top of the field.</span></li>
<li value=13><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">OK</span><span class="f_NumberedList"> button to save the Message definition.</span></li>
</ol>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Notes: </span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><ul style="text-indent: 0px; margin-left: 14px; list-style-position: outside;">
<li><span class="f_TiporNoteText">You can <a href="changing_the_timing_details.htm">change the timing details</a> of a message on the </span><span class="f_UIControl">Timing Details</span><span class="f_TiporNoteText"> dialog, and emphasize the sequence of closely-ordered messages using <a href="general_ordering.htm">General Ordering</a>.</span></li>
<li><span class="f_TiporNoteText">To toggle the numbering of messages on a Sequence diagram, select or deselect the </span><span class="f_TiporNoteText" style="font-weight: bold;"><a href="sequencediagrams.htm">Show Sequence Numbering</a></span><span class="f_TiporNoteText"><a href="sequencediagrams.htm"> checkbox</a> on the </span><span class="f_UIControl">Options</span><span class="f_TiporNoteText"> dialog.</span></li>
</ul>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Co-Region Notation</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">Co-Region notation</span><span class="f_BodyText"> can be used as a short hand for parallel combined fragments. To access the </span><span class="f_MenuKeyField">Co-Region</span><span class="f_BodyText"> submenu, right-click on a connector in a Sequence diagram and select the </span><span class="f_MenuKeyField">Co-Region</span><span class="f_BodyText"> menu option. There are four sub-options available:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1" style="font-weight: bold;">Start at head </span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">End at head</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">Start at tail</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">End at tail</span><span class="f_Bulletlist1">.</span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Toolbox Icon</span></p>
<p class="p_TextIndentedL2"><img src="message.png" width="167" height="24" border="0" alt="Message"></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
